Xbasic

SQL::ResultSetToFormattedString Method

Syntax

dim result as C = toFormattedString([RowFormattingOptions as SQL::RowFormattingOptions [, RowsToCopy as N [, StartRow as N [, ReferenceColumns as SQL::TableInfo [, UserContext as P]]]]])

Arguments

RowFormattingOptionsSQL::RowFormattingOptions

Defines how the data should be formatted in the string. See SQL::RowFormattingOptions for more information.

RowsToCopyNumeric

Default = -1 (all). The number of rows to copy.

StartRowNumeric

Default = 1 (first). The first row to copy.

ReferenceColumnsSQL::TableInfo

When data is formatted for a column in the result set: (1) if ReferenceColumns has a column with a matching name, that object will be used to format the data; (2) otherwise the ColumnInfo property of the result set is used to format the data.

UserContextPointer

The user context is passed into the evaluation of the expression when data is formatted.

Returns

resultCharacter

Returns the results as a formatted string.

Description

Copy the ResultSet to a string.